Accela Engineering Event Scripts

Several features in Civic Platform include event scripts in JavaScript. The Accela Engineering department creates the event scripts and adds them within Civic Platform. These Engineering event scripts, listed in this appendix, require the Accela Services Implementation staff to customize them so they can function for your agency.

The Accela Services Implementation team maintains their own list of commonly used scripts, and also handle requests to create scripts. Accela Services Implementation staff can modify or create event scripts to provide unique functionality for an agency.

Only Accela Services Implementation staff or IT agency administrators who are performing agency-wide functions should customize the event scripts. For further information on working with scripts, refer to Chapter 18, “Event Manager and Script Engine.” For instructions on writing a script, see Chapter 19, “Writing Scripts.” Both of these chapters are in the Accela Civic Platform Administrator Guide.

 

From Civic Platform 6.7.0 and upwards, Civic Platform Classic Administration provides all of the event scripts that the Accela Engineering department created. To locate the list of event scripts, follow the directions indicated in in this Appendix.

This appendix lists all the available event scripts in Citizen Access.

Topics

Accessing Event Scripts

To access the event scripts, log in to Civic Platform Classic Administration. Click the Admin Tools tab, and locate Scripts under the Events menu item. Alternately, scroll to Event Manager and click the Scripts link. For an illustration on accessing scripts, refer to .

Only experienced programmers or agency administrators should use this feature. Improperly written scripts can adversely affect your system, and can incorrectly alter or delete data for many records. Make sure you write custom scripts carefully and test them before you implement them. For further instructions on writing scripts, see the Accela Civic Platform Scripting Guide.

 

Accessing Scripts

 

 

 

To modify the script

Go to Civic Platform Classic Administration > Admin Tools tab

Under the Events menu, click the Scripts link.

Civic Platform displays the Scripts -Search page.

Enter the first few characters of the script in the Script Code or Script Title fields. Event scripts typically share the same Code and Title names. You can enter the characters in uppercase or lowercase.

Civic Platform displays the Scripts - List page.

Click the red dot next to the script you want to modify. For instructions on writing and testing scripts, refer to the Accela Civic Platform Scripting Guide.

Citizen Access Events

This section provides the event scripts related to Citizen Access.

Registration and Login

You can use the following event scripts during registration and login:

OnLoginBefore

OnLoginAfter

RegistrationSubmitAfter

RegistrationSubmitBefore

Accela Asset Management (AAM)

You can use the following event scripts for Accela asset management:

AssetSubmitBefore

AssetSubmitAfter

AssetUpdateBefore

AssetUpdateAfter

ConditionAssessmentSubmitBefore

ConditionAssessmentSubmitAfter

ConditionAssessmentUpdateBefore

ConditionAssessmentUpdateAfter

PartTransactionSubmitBefore

PartTransactionSubmitAfter

PartTransactionUpdateBefore

PartTransactionUpdateAfter

Address Type

You can use the following event scripts with address types:

GetAddressWithTypeByCAPId

GetAddressWithTypeByPK

RemoveAddressWithType

ASI

You can use the following event scripts for application-specific information groups and subgroups:

AddReferenceASIItemsToCAP

CopyASIItemsFromCAPToCAP

RemoveSubgroupsFromCAP [08ACC-03640]

APO

You can use the following event scripts for address, parcel, owner data (APO):

Add_RemoveCapOwners

GetOwnersByParcel

Condition

You can use the following event scripts for conditions:

ApplicationSubmitAfter4ConditionGroup

PartialCapConditionEmseTest

Education

You can use the following event scripts for education:

ApplicationSubmitAfter

ContinuingEducationUpdateAfter

ExaminationUpdateAfter

ExaminationUpdateBefore

EducationUpdateAfter

Fees

You can use the following event scripts for fees:

FeeEstimateAfter4ACAScript

FeeScript. You can call the EMSE method editFeeNotes in FeeScript model, and also use method editFeeNotes to edit fee notes on any single fee item.

Inspection

You can use the following event scripts for inspections:

GetInspectorsWorkload

UpdateInspectionForSuperVisor

UpdateInspectionMilestone

InspectionScheduleAfter

InspectionScheduleBefore

Internationalization

You can use the following event scripts for the internationalization feature:

ApplicationStatusUpdateBefore [08ACC-05789]

CheckTradeNameDuplicate [08ACC-05789]

CloneCapCondition

CopyCapConditionFromSTDCondition

DisplayLocalizedMessageText

CopyCapInfoFromTradeNameToTradeLicense [08ACC-03673]

License

You can use the following event scripts for license records:

ApplicationSubmitAfter4Renew

PaymentReceiveAfter4Renew

WorkflowTaskUpdateAfter4Renew

You can use the following event scripts for license renewal:

ApplicationSubmitAfter

PaymentReceiveAfter

WorkflowTaskUpdateAfter

Convert2RealCapAfter4Renew

Payment

You can use the following event scripts for payments:

PaymentReceiveAfter

VoidPaymentBefore: The event triggers immediately before the void information is committed to the database. The event passes all relevant void parameters to the script. The script can cancel the payment and return custom result codes.

VoidPaymentAfter: The event triggers after Citizen Access posts the void information to the database. The event passes all relevant void parameters to the script.

PaymentReceiveAfter4RenewTransferDoc

FinishOnlinePayment4TransferDoc

Portlet

You can use the following event scripts for portlets:

getRefASISubgroups

getCAPASISubgroup

addRefASISubgroupsToCAP

removeASISubgroupsFromCAP

copyASISubgroups

getScreenListBySPEAR

Public User

You can use the following event scripts for public users:

PublicUserEmseTest

Records

You can use the following event scripts for general records:

ApplicationSubmitAfter

ApplicationSubmitBefore

CreateCAPForDetailDesc

GetCapByType

UpdateCAPForDetailDesc

PartialCapConditionEmseTest

LPAssociatedCapTest(InAStep)

LPAssociatedCapTest2(StepByStep)

clearExpiredIncompleteCAP. You can use the script to clear incomplete applications (CAPs) from Civic Platform. For more information, see “Deleting Partially Completed Applications” in the “Maintaining Fees” chapter in the Accela Civic Platform Administrator Guide.

Reports

You can use the following event scripts for reports:

SendReportInEmail-1

SendReportInEmail-2

Sets

The event scripts related to Set Parameters are:

GetAddressSetParameters

GetLicProfessionalSetParameters

AuditSetDetailUserExecuteAfter

Sets of Sets

The event script related to Sets of Sets is:

PaymentReceiveAfter

Time Accounting

The event scripts related to Time Accounting are:

GetTimeLog

LockTimeAccounting

TimeAccountingAddAfter

TimeAccountingAddBefore

TimeAccountingDeleteAfter

TimeAccountingDeleteBefore

TimeAccountingUpdateAfter

TimeAccountingUpdateBefore

V360InspectionResultSubmitBefore

WorkflowTaskUpdBefore

Trust Account

The event scripts related to Trust Account are:

EMSEPayFromTrustAccount

Valuation Calculator Versioning

The event scripts related to Valuation Calculator Versioning are:

ValuationCalculator_EMSE_Test.txt

Workflow

The event scripts related to Workflow are:

WorkflowEMSEEnhancements

WorkflowTaskUpdateAfter4Renew4TransferDoc4AbuDhabi